home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / dejagnu.lha / dejagnu-1.0.1 / tcl / tclUtil.c < prev    next >
C/C++ Source or Header  |  1993-02-13  |  37KB  |  1,455 lines
  1. /* 
  2.  * tclUtil.c --
  3.  *
  4.  *    This file contains utility procedures that are used by many Tcl
  5.  *    commands.
  6.  *
  7.  * Copyright 1987-1991 Regents of the University of California
  8.  * Permission to use, copy, modify, and distribute this
  9.  * software and its documentation for any purpose and without
  10.  * fee is hereby granted, provided that the above copyright
  11.  * notice appear in all copies.  The University of California
  12.  * makes no representations about the suitability of this
  13.  * software for any purpose.  It is provided "as is" without
  14.  * express or implied warranty.
  15.  */
  16.  
  17. #include "tclInt.h"
  18.  
  19. /*
  20.  * The following values are used in the flags returned by Tcl_ScanElement
  21.  * and used by Tcl_ConvertElement.  The value TCL_DONT_USE_BRACES is also
  22.  * defined in tcl.h;  make sure its value doesn't overlap with any of the
  23.  * values below.
  24.  *
  25.  * TCL_DONT_USE_BRACES -    1 means the string mustn't be enclosed in
  26.  *                braces (e.g. it contains unmatched braces,
  27.  *                or ends in a backslash character, or user
  28.  *                just doesn't want braces);  handle all
  29.  *                special characters by adding backslashes.
  30.  * USE_BRACES -            1 means the string contains a special
  31.  *                character that can be handled simply by
  32.  *                enclosing the entire argument in braces.
  33.  * BRACES_UNMATCHED -        1 means that braces aren't properly matched
  34.  *                in the argument.
  35.  */
  36.  
  37. #define USE_BRACES        2
  38. #define BRACES_UNMATCHED    4
  39.  
  40. /*
  41.  * The variable below is set to NULL before invoking regexp functions
  42.  * and checked after those functions.  If an error occurred then regerror
  43.  * will set the variable to point to a (static) error message.  This
  44.  * mechanism unfortunately does not support multi-threading, but then
  45.  * neither does the rest of the regexp facilities.
  46.  */
  47.  
  48. char *tclRegexpError = NULL;
  49.  
  50. /*
  51.  * Function prototypes for local procedures in this file:
  52.  */
  53.  
  54. static void        SetupAppendBuffer _ANSI_ARGS_((Interp *iPtr,
  55.                 int newSpace));
  56.  
  57. /*
  58.  *----------------------------------------------------------------------
  59.  *
  60.  * TclFindElement --
  61.  *
  62.  *    Given a pointer into a Tcl list, locate the first (or next)
  63.  *    element in the list.
  64.  *
  65.  * Results:
  66.  *    The return value is normally TCL_OK, which means that the
  67.  *    element was successfully located.  If TCL_ERROR is returned
  68.  *    it means that list didn't have proper list structure;
  69.  *    interp->result contains a more detailed error message.
  70.  *
  71.  *    If TCL_OK is returned, then *elementPtr will be set to point
  72.  *    to the first element of list, and *nextPtr will be set to point
  73.  *    to the character just after any white space following the last
  74.  *    character that's part of the element.  If this is the last argument
  75.  *    in the list, then *nextPtr will point to the NULL character at the
  76.  *    end of list.  If sizePtr is non-NULL, *sizePtr is filled in with
  77.  *    the number of characters in the element.  If the element is in
  78.  *    braces, then *elementPtr will point to the character after the
  79.  *    opening brace and *sizePtr will not include either of the braces.
  80.  *    If there isn't an element in the list, *sizePtr will be zero, and
  81.  *    both *elementPtr and *termPtr will refer to the null character at
  82.  *    the end of list.  Note:  this procedure does NOT collapse backslash
  83.  *    sequences.
  84.  *
  85.  * Side effects:
  86.  *    None.
  87.  *
  88.  *----------------------------------------------------------------------
  89.  */
  90.  
  91. int
  92. TclFindElement(interp, list, elementPtr, nextPtr, sizePtr, bracePtr)
  93.     Tcl_Interp *interp;        /* Interpreter to use for error reporting. */
  94.     register char *list;    /* String containing Tcl list with zero
  95.                  * or more elements (possibly in braces). */
  96.     char **elementPtr;        /* Fill in with location of first significant
  97.                  * character in first element of list. */
  98.     char **nextPtr;        /* Fill in with location of character just
  99.                  * after all white space following end of
  100.                  * argument (i.e. next argument or end of
  101.                  * list). */
  102.     int *sizePtr;        /* If non-zero, fill in with size of
  103.                  * element. */
  104.     int *bracePtr;        /* If non-zero fill in with non-zero/zero
  105.                  * to indicate that arg was/wasn't
  106.                  * in braces. */
  107. {
  108.     register char *p;
  109.     int openBraces = 0;
  110.     int inQuotes = 0;
  111.     int size;
  112.  
  113.     /*
  114.      * Skim off leading white space and check for an opening brace or
  115.      * quote.   Note:  use of "isascii" below and elsewhere in this
  116.      * procedure is a temporary hack (7/27/90) because Mx uses characters
  117.      * with the high-order bit set for some things.  This should probably
  118.      * be changed back eventually, or all of Tcl should call isascii.
  119.      */
  120.  
  121.     while (isascii(*list) && isspace(*list)) {
  122.     list++;
  123.     }
  124.     if (*list == '{') {
  125.     openBraces = 1;
  126.     list++;
  127.     } else if (*list == '"') {
  128.     inQuotes = 1;
  129.     list++;
  130.     }
  131.     if (bracePtr != 0) {
  132.     *bracePtr = openBraces;
  133.     }
  134.     p = list;
  135.  
  136.     /*
  137.      * Find the end of the element (either a space or a close brace or
  138.      * the end of the string).
  139.      */
  140.  
  141.     while (1) {
  142.     switch (*p) {
  143.  
  144.         /*
  145.          * Open brace: don't treat specially unless the element is
  146.          * in braces.  In this case, keep a nesting count.
  147.          */
  148.  
  149.         case '{':
  150.         if (openBraces != 0) {
  151.             openBraces++;
  152.         }
  153.         break;
  154.  
  155.         /*
  156.          * Close brace: if element is in braces, keep nesting
  157.          * count and quit when the last close brace is seen.
  158.          */
  159.  
  160.         case '}':
  161.         if (openBraces == 1) {
  162.             char *p2;
  163.  
  164.             size = p - list;
  165.             p++;
  166.             if ((isascii(*p) && isspace(*p)) || (*p == 0)) {
  167.             goto done;
  168.             }
  169.             for (p2 = p; (*p2 != 0) && (!isspace(*p2)) && (p2 < p+20);
  170.                 p2++) {
  171.             /* null body */
  172.             }
  173.             Tcl_ResetResult(interp);
  174.             sprintf(interp->result,
  175.                 "list element in braces followed by \"%.*s\" instead of space",
  176.                 p2-p, p);
  177.             return TCL_ERROR;
  178.         } else if (openBraces != 0) {
  179.             openBraces--;
  180.         }
  181.         break;
  182.  
  183.         /*
  184.          * Backslash:  skip over everything up to the end of the
  185.          * backslash sequence.
  186.          */
  187.  
  188.         case '\\': {
  189.         int size;
  190.  
  191.         (void) Tcl_Backslash(p, &size);
  192.         p += size - 1;
  193.         break;
  194.         }
  195.  
  196.         /*
  197.          * Space: ignore if element is in braces or quotes;  otherwise
  198.          * terminate element.
  199.          */
  200.  
  201.         case ' ':
  202.         case '\f':
  203.         case '\n':
  204.         case '\r':
  205.         case '\t':
  206.         case '\v':
  207.         if ((openBraces == 0) && !inQuotes) {
  208.             size = p - list;
  209.             goto done;
  210.         }
  211.         break;
  212.  
  213.         /*
  214.          * Double-quote:  if element is in quotes then terminate it.
  215.          */
  216.  
  217.         case '"':
  218.         if (inQuotes) {
  219.             char *p2;
  220.  
  221.             size = p-list;
  222.             p++;
  223.             if ((isascii(*p) && isspace(*p)) || (*p == 0)) {
  224.             goto done;
  225.             }
  226.             for (p2 = p; (*p2 != 0) && (!isspace(*p2)) && (p2 < p+20);
  227.                 p2++) {
  228.             /* null body */
  229.             }
  230.             Tcl_ResetResult(interp);
  231.             sprintf(interp->result,
  232.                 "list element in quotes followed by \"%.*s\" %s",
  233.                 p2-p, p, "instead of space");
  234.             return TCL_ERROR;
  235.         }
  236.         break;
  237.  
  238.         /*
  239.          * End of list:  terminate element.
  240.          */
  241.  
  242.         case 0:
  243.         if (openBraces != 0) {
  244.             Tcl_SetResult(interp, "unmatched open brace in list",
  245.                 TCL_STATIC);
  246.             return TCL_ERROR;
  247.         } else if (inQuotes) {
  248.             Tcl_SetResult(interp, "unmatched open quote in list",
  249.                 TCL_STATIC);
  250.             return TCL_ERROR;
  251.         }
  252.         size = p - list;
  253.         goto done;
  254.  
  255.     }
  256.     p++;
  257.     }
  258.  
  259.     done:
  260.     while (isascii(*p) && isspace(*p)) {
  261.     p++;
  262.     }
  263.     *elementPtr = list;
  264.     *nextPtr = p;
  265.     if (sizePtr != 0) {
  266.     *sizePtr = size;
  267.     }
  268.     return TCL_OK;
  269. }
  270.  
  271. /*
  272.  *----------------------------------------------------------------------
  273.  *
  274.  * TclCopyAndCollapse --
  275.  *
  276.  *    Copy a string and eliminate any backslashes that aren't in braces.
  277.  *
  278.  * Results:
  279.  *    There is no return value.  Count chars. get copied from src
  280.  *    to dst.  Along the way, if backslash sequences are found outside
  281.  *    braces, the backslashes are eliminated in the copy.
  282.  *    After scanning count chars. from source, a null character is
  283.  *    placed at the end of dst.
  284.  *
  285.  * Side effects:
  286.  *    None.
  287.  *
  288.  *----------------------------------------------------------------------
  289.  */
  290.  
  291. void
  292. TclCopyAndCollapse(count, src, dst)
  293.     int count;            /* Total number of characters to copy
  294.                  * from src. */
  295.     register char *src;        /* Copy from here... */
  296.     register char *dst;        /* ... to here. */
  297. {
  298.     register char c;
  299.     int numRead;
  300.  
  301.     for (c = *src; count > 0; src++, c = *src, count--) {
  302.     if (c == '\\') {
  303.         *dst = Tcl_Backslash(src, &numRead);
  304.         if (*dst != 0) {
  305.         dst++;
  306.         }
  307.         src += numRead-1;
  308.         count -= numRead-1;
  309.     } else {
  310.         *dst = c;
  311.         dst++;
  312.     }
  313.     }
  314.     *dst = 0;
  315. }
  316.  
  317. /*
  318.  *----------------------------------------------------------------------
  319.  *
  320.  * Tcl_SplitList --
  321.  *
  322.  *    Splits a list up into its constituent fields.
  323.  *
  324.  * Results
  325.  *    The return value is normally TCL_OK, which means that
  326.  *    the list was successfully split up.  If TCL_ERROR is
  327.  *    returned, it means that "list" didn't have proper list
  328.  *    structure;  interp->result will contain a more detailed
  329.  *    error message.
  330.  *
  331.  *    *argvPtr will be filled in with the address of an array
  332.  *    whose elements point to the elements of list, in order.
  333.  *    *argcPtr will get filled in with the number of valid elements
  334.  *    in the array.  A single block of memory is dynamically allocated
  335.  *    to hold both the argv array and a copy of the list (with
  336.  *    backslashes and braces removed in the standard way).
  337.  *    The caller must eventually free this memory by calling free()
  338.  *    on *argvPtr.  Note:  *argvPtr and *argcPtr are only modified
  339.  *    if the procedure returns normally.
  340.  *
  341.  * Side effects:
  342.  *    Memory is allocated.
  343.  *
  344.  *----------------------------------------------------------------------
  345.  */
  346.  
  347. int
  348. Tcl_SplitList(interp, list, argcPtr, argvPtr)
  349.     Tcl_Interp *interp;        /* Interpreter to use for error reporting. */
  350.     char *list;            /* Pointer to string with list structure. */
  351.     int *argcPtr;        /* Pointer to location to fill in with
  352.                  * the number of elements in the list. */
  353.     char ***argvPtr;        /* Pointer to place to store pointer to array
  354.                  * of pointers to list elements. */
  355. {
  356.     char **argv;
  357.     register char *p;
  358.     int size, i, result, elSize, brace;
  359.     char *element;
  360.  
  361.     /*
  362.      * Figure out how much space to allocate.  There must be enough
  363.      * space for both the array of pointers and also for a copy of
  364.      * the list.  To estimate the number of pointers needed, count
  365.      * the number of space characters in the list.
  366.      */
  367.  
  368.     for (size = 1, p = list; *p != 0; p++) {
  369.     if (isspace(*p)) {
  370.         size++;
  371.     }
  372.     }
  373.     size++;            /* Leave space for final NULL pointer. */
  374.     argv = (char **) ckalloc((unsigned)
  375.         ((size * sizeof(char *)) + (p - list) + 1));
  376.     for (i = 0, p = ((char *) argv) + size*sizeof(char *);
  377.         *list != 0; i++) {
  378.     result = TclFindElement(interp, list, &element, &list, &elSize, &brace);
  379.     if (result != TCL_OK) {
  380.         ckfree((char *) argv);
  381.         return result;
  382.     }
  383.     if (*element == 0) {
  384.         break;
  385.     }
  386.     if (i >= size) {
  387.         ckfree((char *) argv);
  388.         Tcl_SetResult(interp, "internal error in Tcl_SplitList",
  389.             TCL_STATIC);
  390.         return TCL_ERROR;
  391.     }
  392.     argv[i] = p;
  393.     if (brace) {
  394.         strncpy(p, element, elSize);
  395.         p += elSize;
  396.         *p = 0;
  397.         p++;
  398.     } else {
  399.         TclCopyAndCollapse(elSize, element, p);
  400.         p += elSize+1;
  401.     }
  402.     }
  403.  
  404.     argv[i] = NULL;
  405.     *argvPtr = argv;
  406.     *argcPtr = i;
  407.     return TCL_OK;
  408. }
  409.  
  410. /*
  411.  *----------------------------------------------------------------------
  412.  *
  413.  * Tcl_ScanElement --
  414.  *
  415.  *    This procedure is a companion procedure to Tcl_ConvertElement.
  416.  *    It scans a string to see what needs to be done to it (e.g.
  417.  *    add backslashes or enclosing braces) to make the string into
  418.  *    a valid Tcl list element.
  419.  *
  420.  * Results:
  421.  *    The return value is an overestimate of the number of characters
  422.  *    that will be needed by Tcl_ConvertElement to produce a valid
  423.  *    list element from string.  The word at *flagPtr is filled in
  424.  *    with a value needed by Tcl_ConvertElement when doing the actual
  425.  *    conversion.
  426.  *
  427.  * Side effects:
  428.  *    None.
  429.  *
  430.  *----------------------------------------------------------------------
  431.  */
  432.  
  433. int
  434. Tcl_ScanElement(string, flagPtr)
  435.     char *string;        /* String to convert to Tcl list element. */
  436.     int *flagPtr;        /* Where to store information to guide
  437.                  * Tcl_ConvertElement. */
  438. {
  439.     int flags, nestingLevel;
  440.     register char *p;
  441.  
  442.     /*
  443.      * This procedure and Tcl_ConvertElement together do two things:
  444.      *
  445.      * 1. They produce a proper list, one that will yield back the
  446.      * argument strings when evaluated or when disassembled with
  447.      * Tcl_SplitList.  This is the most important thing.
  448.      * 
  449.      * 2. They try to produce legible output, which means minimizing the
  450.      * use of backslashes (using braces instead).  However, there are
  451.      * some situations where backslashes must be used (e.g. an element
  452.      * like "{abc": the leading brace will have to be backslashed.  For
  453.      * each element, one of three things must be done:
  454.      *
  455.      * (a) Use the element as-is (it doesn't contain anything special
  456.      * characters).  This is the most desirable option.
  457.      *
  458.      * (b) Enclose the element in braces, but leave the contents alone.
  459.      * This happens if the element contains embedded space, or if it
  460.      * contains characters with special interpretation ($, [, ;, or \),
  461.      * or if it starts with a brace or double-quote, or if there are
  462.      * no characters in the element.
  463.      *
  464.      * (c) Don't enclose the element in braces, but add backslashes to
  465.      * prevent special interpretation of special characters.  This is a
  466.      * last resort used when the argument would normally fall under case
  467.      * (b) but contains unmatched braces.  It also occurs if the last
  468.      * character of the argument is a backslash or if the element contains
  469.      * a backslash followed by newline.
  470.      *
  471.      * The procedure figures out how many bytes will be needed to store
  472.      * the result (actually, it overestimates).  It also collects information
  473.      * about the element in the form of a flags word.
  474.      */
  475.  
  476.     nestingLevel = 0;
  477.     flags = 0;
  478.     if (string == NULL) {
  479.     string = "";
  480.     }
  481.     p = string;
  482.     if ((*p == '{') || (*p == '"') || (*p == 0)) {
  483.     flags |= USE_BRACES;
  484.     }
  485.     for ( ; *p != 0; p++) {
  486.     switch (*p) {
  487.         case '{':
  488.         nestingLevel++;
  489.         break;
  490.         case '}':
  491.         nestingLevel--;
  492.         if (nestingLevel < 0) {
  493.             flags |= TCL_DONT_USE_BRACES|BRACES_UNMATCHED;
  494.         }
  495.         break;
  496.         case '[':
  497.         case '$':
  498.         case ';':
  499.         case ' ':
  500.         case '\f':
  501.         case '\n':
  502.         case '\r':
  503.         case '\t':
  504.         case '\v':
  505.         flags |= USE_BRACES;
  506.         break;
  507.         case '\\':
  508.         if ((p[1] == 0) || (p[1] == '\n')) {
  509.             flags = TCL_DONT_USE_BRACES;
  510.         } else {
  511.             int size;
  512.  
  513.             (void) Tcl_Backslash(p, &size);
  514.             p += size-1;
  515.             flags |= USE_BRACES;
  516.         }
  517.         break;
  518.     }
  519.     }
  520.     if (nestingLevel != 0) {
  521.     flags = TCL_DONT_USE_BRACES | BRACES_UNMATCHED;
  522.     }
  523.     *flagPtr = flags;
  524.  
  525.     /*
  526.      * Allow enough space to backslash every character plus leave
  527.      * two spaces for braces.
  528.      */
  529.  
  530.     return 2*(p-string) + 2;
  531. }
  532.  
  533. /*
  534.  *----------------------------------------------------------------------
  535.  *
  536.  * Tcl_ConvertElement --
  537.  *
  538.  *    This is a companion procedure to Tcl_ScanElement.  Given the
  539.  *    information produced by Tcl_ScanElement, this procedure converts
  540.  *    a string to a list element equal to that string.
  541.  *
  542.  * Results:
  543.  *    Information is copied to *dst in the form of a list element
  544.  *    identical to src (i.e. if Tcl_SplitList is applied to dst it
  545.  *    will produce a string identical to src).  The return value is
  546.  *    a count of the number of characters copied (not including the
  547.  *    terminating NULL character).
  548.  *
  549.  * Side effects:
  550.  *    None.
  551.  *
  552.  *----------------------------------------------------------------------
  553.  */
  554.  
  555. int
  556. Tcl_ConvertElement(src, dst, flags)
  557.     register char *src;        /* Source information for list element. */
  558.     char *dst;            /* Place to put list-ified element. */
  559.     int flags;            /* Flags produced by Tcl_ScanElement. */
  560. {
  561.     register char *p = dst;
  562.  
  563.     /*
  564.      * See the comment block at the beginning of the Tcl_ScanElement
  565.      * code for details of how this works.
  566.      */
  567.  
  568.     if (src == NULL) {
  569.     src = "";
  570.     }
  571.     if ((flags & USE_BRACES) && !(flags & TCL_DONT_USE_BRACES)) {
  572.     *p = '{';
  573.     p++;
  574.     for ( ; *src != 0; src++, p++) {
  575.         *p = *src;
  576.     }
  577.     *p = '}';
  578.     p++;
  579.     } else if (*src == 0) {
  580.     /*
  581.      * If string is empty but can't use braces, then use special
  582.      * backslash sequence that maps to empty string.
  583.      */
  584.  
  585.     p[0] = '\\';
  586.     p[1] = '0';
  587.     p += 2;
  588.     } else {
  589.     for (; *src != 0 ; src++) {
  590.         switch (*src) {
  591.         case ']':
  592.         case '[':
  593.         case '$':
  594.         case ';':
  595.         case ' ':
  596.         case '\\':
  597.         case '"':
  598.             *p = '\\';
  599.             p++;
  600.             break;
  601.         case '{':
  602.         case '}':
  603.             if (flags & BRACES_UNMATCHED) {
  604.             *p = '\\';
  605.             p++;
  606.             }
  607.             break;
  608.         case '\f':
  609.             *p = '\\';
  610.             p++;
  611.             *p = 'f';
  612.             p++;
  613.             continue;
  614.         case '\n':
  615.             *p = '\\';
  616.             p++;
  617.             *p = 'n';
  618.             p++;
  619.             continue;
  620.         case '\r':
  621.             *p = '\\';
  622.             p++;
  623.             *p = 'r';
  624.             p++;
  625.             continue;
  626.         case '\t':
  627.             *p = '\\';
  628.             p++;
  629.             *p = 't';
  630.             p++;
  631.             continue;
  632.         case '\v':
  633.             *p = '\\';
  634.             p++;
  635.             *p = 'v';
  636.             p++;
  637.             continue;
  638.         }
  639.         *p = *src;
  640.         p++;
  641.     }
  642.     }
  643.     *p = '\0';
  644.     return p-dst;
  645. }
  646.  
  647. /*
  648.  *----------------------------------------------------------------------
  649.  *
  650.  * Tcl_Merge --
  651.  *
  652.  *    Given a collection of strings, merge them together into a
  653.  *    single string that has proper Tcl list structured (i.e.
  654.  *    Tcl_SplitList may be used to retrieve strings equal to the
  655.  *    original elements, and Tcl_Eval will parse the string back
  656.  *    into its original elements).
  657.  *
  658.  * Results:
  659.  *    The return value is the address of a dynamically-allocated
  660.  *    string containing the merged list.
  661.  *
  662.  * Side effects:
  663.  *    None.
  664.  *
  665.  *----------------------------------------------------------------------
  666.  */
  667.  
  668. char *
  669. Tcl_Merge(argc, argv)
  670.     int argc;            /* How many strings to merge. */
  671.     char **argv;        /* Array of string values. */
  672. {
  673. #   define LOCAL_SIZE 20
  674.     int localFlags[LOCAL_SIZE], *flagPtr;
  675.     int numChars;
  676.     char *result;
  677.     register char *dst;
  678.     int i;
  679.  
  680.     /*
  681.      * Pass 1: estimate space, gather flags.
  682.      */
  683.  
  684.     if (argc <= LOCAL_SIZE) {
  685.     flagPtr = localFlags;
  686.     } else {
  687.     flagPtr = (int *) ckalloc((unsigned) argc*sizeof(int));
  688.     }
  689.     numChars = 1;
  690.     for (i = 0; i < argc; i++) {
  691.     numChars += Tcl_ScanElement(argv[i], &flagPtr[i]) + 1;
  692.     }
  693.  
  694.     /*
  695.      * Pass two: copy into the result area.
  696.      */
  697.  
  698.     result = (char *) ckalloc((unsigned) numChars);
  699.     dst = result;
  700.     for (i = 0; i < argc; i++) {
  701.     numChars = Tcl_ConvertElement(argv[i], dst, flagPtr[i]);
  702.     dst += numChars;
  703.     *dst = ' ';
  704.     dst++;
  705.     }
  706.     if (dst == result) {
  707.     *dst = 0;
  708.     } else {
  709.     dst[-1] = 0;
  710.     }
  711.  
  712.     if (flagPtr != localFlags) {
  713.     ckfree((char *) flagPtr);
  714.     }
  715.     return result;
  716. }
  717.  
  718. /*
  719.  *----------------------------------------------------------------------
  720.  *
  721.  * Tcl_Concat --
  722.  *
  723.  *    Concatenate a set of strings into a single large string.
  724.  *
  725.  * Results:
  726.  *    The return value is dynamically-allocated string containing
  727.  *    a concatenation of all the strings in argv, with spaces between
  728.  *    the original argv elements.
  729.  *
  730.  * Side effects:
  731.  *    Memory is allocated for the result;  the caller is responsible
  732.  *    for freeing the memory.
  733.  *
  734.  *----------------------------------------------------------------------
  735.  */
  736.  
  737. char *
  738. Tcl_Concat(argc, argv)
  739.     int argc;            /* Number of strings to concatenate. */
  740.     char **argv;        /* Array of strings to concatenate. */
  741. {
  742.     int totalSize, i;
  743.     register char *p;
  744.     char *result;
  745.  
  746.     for (totalSize = 1, i = 0; i < argc; i++) {
  747.     totalSize += strlen(argv[i]) + 1;
  748.     }
  749.     result = (char *) ckalloc((unsigned) totalSize);
  750.     if (argc == 0) {
  751.     *result = '\0';
  752.     return result;
  753.     }
  754.     for (p = result, i = 0; i < argc; i++) {
  755.     char *element;
  756.     int length;
  757.  
  758.     /*
  759.      * Clip white space off the front and back of the string
  760.      * to generate a neater result, and ignore any empty
  761.      * elements.
  762.      */
  763.  
  764.     element = argv[i];
  765.     while (isspace(*element)) {
  766.         element++;
  767.     }
  768.     for (length = strlen(element);
  769.         (length > 0) && (isspace(element[length-1]));
  770.         length--) {
  771.         /* Null loop body. */
  772.     }
  773.     if (length == 0) {
  774.         continue;
  775.     }
  776.     (void) strncpy(p, element, length);
  777.     p += length;
  778.     *p = ' ';
  779.     p++;
  780.     }
  781.     if (p != result) {
  782.     p[-1] = 0;
  783.     } else {
  784.     *p = 0;
  785.     }
  786.     return result;
  787. }
  788.  
  789. /*
  790.  *----------------------------------------------------------------------
  791.  *
  792.  * Tcl_StringMatch --
  793.  *
  794.  *    See if a particular string matches a particular pattern.
  795.  *
  796.  * Results:
  797.  *    The return value is 1 if string matches pattern, and
  798.  *    0 otherwise.  The matching operation permits the following
  799.  *    special characters in the pattern: *?\[] (see the manual
  800.  *    entry for details on what these mean).
  801.  *
  802.  * Side effects:
  803.  *    None.
  804.  *
  805.  *----------------------------------------------------------------------
  806.  */
  807.  
  808. int
  809. Tcl_StringMatch(string, pattern)
  810.     register char *string;    /* String. */
  811.     register char *pattern;    /* Pattern, which may contain
  812.                  * special characters. */
  813. {
  814.     char c2;
  815.  
  816.     while (1) {
  817.     /* See if we're at the end of both the pattern and the string.
  818.      * If so, we succeeded.  If we're at the end of the pattern
  819.      * but not at the end of the string, we failed.
  820.      */
  821.     
  822.     if (*pattern == 0) {
  823.         if (*string == 0) {
  824.         return 1;
  825.         } else {
  826.         return 0;
  827.         }
  828.     }
  829.     if ((*string == 0) && (*pattern != '*')) {
  830.         return 0;
  831.     }
  832.  
  833.     /* Check for a "*" as the next pattern character.  It matches
  834.      * any substring.  We handle this by calling ourselves
  835.      * recursively for each postfix of string, until either we
  836.      * match or we reach the end of the string.
  837.      */
  838.     
  839.     if (*pattern == '*') {
  840.         pattern += 1;
  841.         if (*pattern == 0) {
  842.         return 1;
  843.         }
  844.         while (1) {
  845.         if (Tcl_StringMatch(string, pattern)) {
  846.             return 1;
  847.         }
  848.         if (*string == 0) {
  849.             return 0;
  850.         }
  851.         string += 1;
  852.         }
  853.     }
  854.     
  855.     /* Check for a "?" as the next pattern character.  It matches
  856.      * any single character.
  857.      */
  858.  
  859.     if (*pattern == '?') {
  860.         goto thisCharOK;
  861.     }
  862.  
  863.     /* Check for a "[" as the next pattern character.  It is followed
  864.      * by a list of characters that are acceptable, or by a range
  865.      * (two characters separated by "-").
  866.      */
  867.     
  868.     if (*pattern == '[') {
  869.         pattern += 1;
  870.         while (1) {
  871.         if ((*pattern == ']') || (*pattern == 0)) {
  872.             return 0;
  873.         }
  874.         if (*pattern == *string) {
  875.             break;
  876.         }
  877.         if (pattern[1] == '-') {
  878.             c2 = pattern[2];
  879.             if (c2 == 0) {
  880.             return 0;
  881.             }
  882.             if ((*pattern <= *string) && (c2 >= *string)) {
  883.             break;
  884.             }
  885.             if ((*pattern >= *string) && (c2 <= *string)) {
  886.             break;
  887.             }
  888.             pattern += 2;
  889.         }
  890.         pattern += 1;
  891.         }
  892.         while ((*pattern != ']') && (*pattern != 0)) {
  893.         pattern += 1;
  894.         }
  895.         goto thisCharOK;
  896.     }
  897.     
  898.     /* If the next pattern character is '/', just strip off the '/'
  899.      * so we do exact matching on the character that follows.
  900.      */
  901.     
  902.     if (*pattern == '\\') {
  903.         pattern += 1;
  904.         if (*pattern == 0) {
  905.         return 0;
  906.         }
  907.     }
  908.  
  909.     /* There's no special character.  Just make sure that the next
  910.      * characters of each string match.
  911.      */
  912.     
  913.     if (*pattern != *string) {
  914.         return 0;
  915.     }
  916.  
  917.     thisCharOK: pattern += 1;
  918.     string += 1;
  919.     }
  920. }
  921.  
  922. /*
  923.  *----------------------------------------------------------------------
  924.  *
  925.  * Tcl_SetResult --
  926.  *
  927.  *    Arrange for "string" to be the Tcl return value.
  928.  *
  929.  * Results:
  930.  *    None.
  931.  *
  932.  * Side effects:
  933.  *    interp->result is left pointing either to "string" (if "copy" is 0)
  934.  *    or to a copy of string.
  935.  *
  936.  *----------------------------------------------------------------------
  937.  */
  938.  
  939. void
  940. Tcl_SetResult(interp, string, freeProc)
  941.     Tcl_Interp *interp;        /* Interpreter with which to associate the
  942.                  * return value. */
  943.     char *string;        /* Value to be returned.  If NULL,
  944.                  * the result is set to an empty string. */
  945.     Tcl_FreeProc *freeProc;    /* Gives information about the string:
  946.                  * TCL_STATIC, TCL_VOLATILE, or the address
  947.                  * of a Tcl_FreeProc such as free. */
  948. {
  949.     register Interp *iPtr = (Interp *) interp;
  950.     int length;
  951.     Tcl_FreeProc *oldFreeProc = iPtr->freeProc;
  952.     char *oldResult = iPtr->result;
  953.  
  954.     iPtr->freeProc = freeProc;
  955.     if (string == NULL) {
  956.     iPtr->resultSpace[0] = 0;
  957.     iPtr->result = iPtr->resultSpace;
  958.     iPtr->freeProc = 0;
  959.     } else if (freeProc == TCL_VOLATILE) {
  960.     length = strlen(string);
  961.     if (length > TCL_RESULT_SIZE) {
  962.         iPtr->result = (char *) ckalloc((unsigned) length+1);
  963.         iPtr->freeProc = (Tcl_FreeProc *) free;
  964.     } else {
  965.         iPtr->result = iPtr->resultSpace;
  966.         iPtr->freeProc = 0;
  967.     }
  968.     strcpy(iPtr->result, string);
  969.     } else {
  970.     iPtr->result = string;
  971.     }
  972.  
  973.     /*
  974.      * If the old result was dynamically-allocated, free it up.  Do it
  975.      * here, rather than at the beginning, in case the new result value
  976.      * was part of the old result value.
  977.      */
  978.  
  979.     if (oldFreeProc != 0) {
  980.     if (oldFreeProc == (Tcl_FreeProc *) free) {
  981.         ckfree(oldResult);
  982.     } else {
  983.         (*oldFreeProc)(oldResult);
  984.     }
  985.     }
  986. }
  987.  
  988. /*
  989.  *----------------------------------------------------------------------
  990.  *
  991.  * Tcl_AppendResult --
  992.  *
  993.  *    Append a variable number of strings onto the result already
  994.  *    present for an interpreter.
  995.  *
  996.  * Results:
  997.  *    None.
  998.  *
  999.  * Side effects:
  1000.  *    The result in the interpreter given by the first argument
  1001.  *    is extended by the strings given by the second and following
  1002.  *    arguments (up to a terminating NULL argument).
  1003.  *
  1004.  *----------------------------------------------------------------------
  1005.  */
  1006.  
  1007.     /* VARARGS2 */
  1008. #ifndef lint
  1009. void
  1010. Tcl_AppendResult(va_alist)
  1011. #else
  1012. void
  1013.     /* VARARGS2 */ /* ARGSUSED */
  1014. Tcl_AppendResult(interp, p, va_alist)
  1015.     Tcl_Interp *interp;        /* Interpreter whose result is to be
  1016.                  * extended. */
  1017.     char *p;            /* One or more strings to add to the
  1018.                  * result, terminated with NULL. */
  1019. #endif
  1020.     va_dcl
  1021. {
  1022.     va_list argList;
  1023.     register Interp *iPtr;
  1024.     char *string;
  1025.     int newSpace;
  1026.  
  1027.     /*
  1028.      * First, scan through all the arguments to see how much space is
  1029.      * needed.
  1030.      */
  1031.  
  1032.     va_start(argList);
  1033.     iPtr = va_arg(argList, Interp *);
  1034.     newSpace = 0;
  1035.     while (1) {
  1036.     string = va_arg(argList, char *);
  1037.     if (string == NULL) {
  1038.         break;
  1039.     }
  1040.     newSpace += strlen(string);
  1041.     }
  1042.     va_end(argList);
  1043.  
  1044.     /*
  1045.      * If the append buffer isn't already setup and large enough
  1046.      * to hold the new data, set it up.
  1047.      */
  1048.  
  1049.     if ((iPtr->result != iPtr->appendResult)
  1050.        || ((newSpace + iPtr->appendUsed) >= iPtr->appendAvl)) {
  1051.        SetupAppendBuffer(iPtr, newSpace);
  1052.     }
  1053.  
  1054.     /*
  1055.      * Final step:  go through all the argument strings again, copying
  1056.      * them into the buffer.
  1057.      */
  1058.  
  1059.     va_start(argList);
  1060.     (void) va_arg(argList, Tcl_Interp *);
  1061.     while (1) {
  1062.     string = va_arg(argList, char *);
  1063.     if (string == NULL) {
  1064.         break;
  1065.     }
  1066.     strcpy(iPtr->appendResult + iPtr->appendUsed, string);
  1067.     iPtr->appendUsed += strlen(string);
  1068.     }
  1069.     va_end(argList);
  1070. }
  1071.  
  1072. /*
  1073.  *----------------------------------------------------------------------
  1074.  *
  1075.  * Tcl_AppendElement --
  1076.  *
  1077.  *    Convert a string to a valid Tcl list element and append it
  1078.  *    to the current result (which is ostensibly a list).
  1079.  *
  1080.  * Results:
  1081.  *    None.
  1082.  *
  1083.  * Side effects:
  1084.  *    The result in the interpreter given by the first argument
  1085.  *    is extended with a list element converted from string.  If
  1086.  *    the original result wasn't empty, then a blank is added before
  1087.  *    the converted list element.
  1088.  *
  1089.  *----------------------------------------------------------------------
  1090.  */
  1091.  
  1092. void
  1093. Tcl_AppendElement(interp, string, noSep)
  1094.     Tcl_Interp *interp;        /* Interpreter whose result is to be
  1095.                  * extended. */
  1096.     char *string;        /* String to convert to list element and
  1097.                  * add to result. */
  1098.     int noSep;            /* If non-zero, then don't output a
  1099.                  * space character before this element,
  1100.                  * even if the element isn't the first
  1101.                  * thing in the output buffer. */
  1102. {
  1103.     register Interp *iPtr = (Interp *) interp;
  1104.     int size, flags;
  1105.     char *dst;
  1106.  
  1107.     /*
  1108.      * See how much space is needed, and grow the append buffer if
  1109.      * needed to accommodate the list element.
  1110.      */
  1111.  
  1112.     size = Tcl_ScanElement(string, &flags) + 1;
  1113.     if ((iPtr->result != iPtr->appendResult)
  1114.        || ((size + iPtr->appendUsed) >= iPtr->appendAvl)) {
  1115.        SetupAppendBuffer(iPtr, size+iPtr->appendUsed);
  1116.     }
  1117.  
  1118.     /*
  1119.      * Convert the string into a list element and copy it to the
  1120.      * buffer that's forming.
  1121.      */
  1122.  
  1123.     dst = iPtr->appendResult + iPtr->appendUsed;
  1124.     if (!noSep && (iPtr->appendUsed != 0)) {
  1125.     iPtr->appendUsed++;
  1126.     *dst = ' ';
  1127.     dst++;
  1128.     }
  1129.     iPtr->appendUsed += Tcl_ConvertElement(string, dst, flags);
  1130. }
  1131.  
  1132. /*
  1133.  *----------------------------------------------------------------------
  1134.  *
  1135.  * SetupAppendBuffer --
  1136.  *
  1137.  *    This procedure makes sure that there is an append buffer
  1138.  *    properly initialized for interp, and that it has at least
  1139.  *    enough room to accommodate newSpace new bytes of information.
  1140.  *
  1141.  * Results:
  1142.  *    None.
  1143.  *
  1144.  * Side effects:
  1145.  *    None.
  1146.  *
  1147.  *----------------------------------------------------------------------
  1148.  */
  1149.  
  1150. static void
  1151. SetupAppendBuffer(iPtr, newSpace)
  1152.     register Interp *iPtr;    /* Interpreter whose result is being set up. */
  1153.     int newSpace;        /* Make sure that at least this many bytes
  1154.                  * of new information may be added. */
  1155. {
  1156.     int totalSpace;
  1157.  
  1158.     /*
  1159.      * Make the append buffer larger, if that's necessary, then
  1160.      * copy the current result into the append buffer and make the
  1161.      * append buffer the official Tcl result.
  1162.      */
  1163.  
  1164.     if (iPtr->result != iPtr->appendResult) {
  1165.     /*
  1166.      * If an oversized buffer was used recently, then free it up
  1167.      * so we go back to a smaller buffer.  This avoids tying up
  1168.      * memory forever after a large operation.
  1169.      */
  1170.  
  1171.     if (iPtr->appendAvl > 500) {
  1172.         ckfree(iPtr->appendResult);
  1173.         iPtr->appendResult = NULL;
  1174.         iPtr->appendAvl = 0;
  1175.     }
  1176.     iPtr->appendUsed = strlen(iPtr->result);
  1177.     }
  1178.     totalSpace = newSpace + iPtr->appendUsed;
  1179.     if (totalSpace >= iPtr->appendAvl) {
  1180.     char *new;
  1181.  
  1182.     if (totalSpace < 100) {
  1183.         totalSpace = 200;
  1184.     } else {
  1185.         totalSpace *= 2;
  1186.     }
  1187.     new = (char *) ckalloc((unsigned) totalSpace);
  1188.     strcpy(new, iPtr->result);
  1189.     if (iPtr->appendResult != NULL) {
  1190.         ckfree(iPtr->appendResult);
  1191.     }
  1192.     iPtr->appendResult = new;
  1193.     iPtr->appendAvl = totalSpace;
  1194.     } else if (iPtr->result != iPtr->appendResult) {
  1195.     strcpy(iPtr->appendResult, iPtr->result);
  1196.     }
  1197.     Tcl_FreeResult(iPtr);
  1198.     iPtr->result = iPtr->appendResult;
  1199. }
  1200.  
  1201. /*
  1202.  *----------------------------------------------------------------------
  1203.  *
  1204.  * Tcl_ResetResult --
  1205.  *
  1206.  *    This procedure restores the result area for an interpreter
  1207.  *    to its default initialized state, freeing up any memory that
  1208.  *    may have been allocated for the result and clearing any
  1209.  *    error information for the interpreter.
  1210.  *
  1211.  * Results:
  1212.  *    None.
  1213.  *
  1214.  * Side effects:
  1215.  *    None.
  1216.  *
  1217.  *----------------------------------------------------------------------
  1218.  */
  1219.  
  1220. void
  1221. Tcl_ResetResult(interp)
  1222.     Tcl_Interp *interp;        /* Interpreter for which to clear result. */
  1223. {
  1224.     register Interp *iPtr = (Interp *) interp;
  1225.  
  1226.     Tcl_FreeResult(iPtr);
  1227.     iPtr->result = iPtr->resultSpace;
  1228.     iPtr->resultSpace[0] = 0;
  1229.     iPtr->flags &=
  1230.         ~(ERR_ALREADY_LOGGED | ERR_IN_PROGRESS | ERROR_CODE_SET);
  1231. }
  1232.  
  1233. /*
  1234.  *----------------------------------------------------------------------
  1235.  *
  1236.  * Tcl_SetErrorCode --
  1237.  *
  1238.  *    This procedure is called to record machine-readable information
  1239.  *    about an error that is about to be returned.
  1240.  *
  1241.  * Results:
  1242.  *    None.
  1243.  *
  1244.  * Side effects:
  1245.  *    The errorCode global variable is modified to hold all of the
  1246.  *    arguments to this procedure, in a list form with each argument
  1247.  *    becoming one element of the list.  A flag is set internally
  1248.  *    to remember that errorCode has been set, so the variable doesn't
  1249.  *    get set automatically when the error is returned.
  1250.  *
  1251.  *----------------------------------------------------------------------
  1252.  */
  1253.     /* VARARGS2 */
  1254. #ifndef lint
  1255. void
  1256. Tcl_SetErrorCode(va_alist)
  1257. #else
  1258. void
  1259.     /* VARARGS2 */ /* ARGSUSED */
  1260. Tcl_SetErrorCode(interp, p, va_alist)
  1261.     Tcl_Interp *interp;        /* Interpreter whose errorCode variable is
  1262.                  * to be set. */
  1263.     char *p;            /* One or more elements to add to errorCode,
  1264.                  * terminated with NULL. */
  1265. #endif
  1266.     va_dcl
  1267. {
  1268.     va_list argList;
  1269.     char *string;
  1270.     int flags;
  1271.     Interp *iPtr;
  1272.  
  1273.     /*
  1274.      * Scan through the arguments one at a time, appending them to
  1275.      * $errorCode as list elements.
  1276.      */
  1277.  
  1278.     va_start(argList);
  1279.     iPtr = va_arg(argList, Interp *);
  1280.     flags = TCL_GLOBAL_ONLY | TCL_LIST_ELEMENT;
  1281.     while (1) {
  1282.     string = va_arg(argList, char *);
  1283.     if (string == NULL) {
  1284.         break;
  1285.     }
  1286.     (void) Tcl_SetVar2((Tcl_Interp *) iPtr, "errorCode",
  1287.         (char *) NULL, string, flags);
  1288.     flags |= TCL_APPEND_VALUE;
  1289.     }
  1290.     va_end(argList);
  1291.     iPtr->flags |= ERROR_CODE_SET;
  1292. }
  1293.  
  1294. /*
  1295.  *----------------------------------------------------------------------
  1296.  *
  1297.  * TclGetListIndex --
  1298.  *
  1299.  *    Parse a list index, which may be either an integer or the
  1300.  *    value "end".
  1301.  *
  1302.  * Results:
  1303.  *    The return value is either TCL_OK or TCL_ERROR.  If it is
  1304.  *    TCL_OK, then the index corresponding to string is left in
  1305.  *    *indexPtr.  If the return value is TCL_ERROR, then string
  1306.  *    was bogus;  an error message is returned in interp->result.
  1307.  *    If a negative index is specified, it is rounded up to 0.
  1308.  *    The index value may be larger than the size of the list
  1309.  *    (this happens when "end" is specified).
  1310.  *
  1311.  * Side effects:
  1312.  *    None.
  1313.  *
  1314.  *----------------------------------------------------------------------
  1315.  */
  1316.  
  1317. int
  1318. TclGetListIndex(interp, string, indexPtr)
  1319.     Tcl_Interp *interp;            /* Interpreter for error reporting. */
  1320.     char *string;            /* String containing list index. */
  1321.     int *indexPtr;            /* Where to store index. */
  1322. {
  1323.     if (isdigit(*string) || (*string == '-')) {
  1324.     if (Tcl_GetInt(interp, string, indexPtr) != TCL_OK) {
  1325.         return TCL_ERROR;
  1326.     }
  1327.     if (*indexPtr < 0) {
  1328.         *indexPtr = 0;
  1329.     }
  1330.     } else if (strncmp(string, "end", strlen(string)) == 0) {
  1331.     *indexPtr = 1<<30;
  1332.     } else {
  1333.     Tcl_AppendResult(interp, "bad index \"", string,
  1334.         "\": must be integer or \"end\"", (char *) NULL);
  1335.     return TCL_ERROR;
  1336.     }
  1337.     return TCL_OK;
  1338. }
  1339.  
  1340. /*
  1341.  *----------------------------------------------------------------------
  1342.  *
  1343.  * TclCompileRegexp --
  1344.  *
  1345.  *    Compile a regular expression into a form suitable for fast
  1346.  *    matching.  This procedure retains a small cache of pre-compiled
  1347.  *    regular expressions in the interpreter, in order to avoid
  1348.  *    compilation costs as much as possible.
  1349.  *
  1350.  * Results:
  1351.  *    The return value is a pointer to the compiled form of string,
  1352.  *    suitable for passing to regexec.  If an error occurred while
  1353.  *    compiling the pattern, then NULL is returned and an error
  1354.  *    message is left in interp->result.
  1355.  *
  1356.  * Side effects:
  1357.  *    The cache of compiled regexp's in interp will be modified to
  1358.  *    hold information for string, if such information isn't already
  1359.  *    present in the cache.
  1360.  *
  1361.  *----------------------------------------------------------------------
  1362.  */
  1363.  
  1364. regexp *
  1365. TclCompileRegexp(interp, string)
  1366.     Tcl_Interp *interp;            /* For use in error reporting. */
  1367.     char *string;            /* String for which to produce
  1368.                      * compiled regular expression. */
  1369. {
  1370.     register Interp *iPtr = (Interp *) interp;
  1371.     int i, length;
  1372.     regexp *result;
  1373.  
  1374.     length = strlen(string);
  1375.     for (i = 0; i < NUM_REGEXPS; i++) {
  1376.     if ((length == iPtr->patLengths[i])
  1377.         && (strcmp(string, iPtr->patterns[i]) == 0)) {
  1378.         /*
  1379.          * Move the matched pattern to the first slot in the
  1380.          * cache and shift the other patterns down one position.
  1381.          */
  1382.  
  1383.         if (i != 0) {
  1384.         int j;
  1385.         char *cachedString;
  1386.  
  1387.         cachedString = iPtr->patterns[i];
  1388.         result = iPtr->regexps[i];
  1389.         for (j = i-1; j >= 0; j--) {
  1390.             iPtr->patterns[j+1] = iPtr->patterns[j];
  1391.             iPtr->patLengths[j+1] = iPtr->patLengths[j];
  1392.             iPtr->regexps[j+1] = iPtr->regexps[j];
  1393.         }
  1394.         iPtr->patterns[0] = cachedString;
  1395.         iPtr->patLengths[0] = length;
  1396.         iPtr->regexps[0] = result;
  1397.         }
  1398.         return iPtr->regexps[0];
  1399.     }
  1400.     }
  1401.  
  1402.     /*
  1403.      * No match in the cache.  Compile the string and add it to the
  1404.      * cache.
  1405.      */
  1406.  
  1407.     tclRegexpError = NULL;
  1408.     result = regcomp(string);
  1409.     if (tclRegexpError != NULL) {
  1410.     Tcl_AppendResult(interp,
  1411.         "couldn't compile regular expression pattern: ",
  1412.         tclRegexpError, (char *) NULL);
  1413.     return NULL;
  1414.     }
  1415.     if (iPtr->patterns[NUM_REGEXPS-1] != NULL) {
  1416.     ckfree(iPtr->patterns[NUM_REGEXPS-1]);
  1417.     ckfree((char *) iPtr->regexps[NUM_REGEXPS-1]);
  1418.     }
  1419.     for (i = NUM_REGEXPS - 2; i >= 0; i--) {
  1420.     iPtr->patterns[i+1] = iPtr->patterns[i];
  1421.     iPtr->patLengths[i+1] = iPtr->patLengths[i];
  1422.     iPtr->regexps[i+1] = iPtr->regexps[i];
  1423.     }
  1424.     iPtr->patterns[0] = (char *) ckalloc((unsigned) (length+1));
  1425.     strcpy(iPtr->patterns[0], string);
  1426.     iPtr->patLengths[0] = length;
  1427.     iPtr->regexps[0] = result;
  1428.     return result;
  1429. }
  1430.  
  1431. /*
  1432.  *----------------------------------------------------------------------
  1433.  *
  1434.  * regerror --
  1435.  *
  1436.  *    This procedure is invoked by the Henry Spencer's regexp code
  1437.  *    when an error occurs.  It saves the error message so it can
  1438.  *    be seen by the code that called Spencer's code.
  1439.  *
  1440.  * Results:
  1441.  *    None.
  1442.  *
  1443.  * Side effects:
  1444.  *    The value of "string" is saved in "tclRegexpError".
  1445.  *
  1446.  *----------------------------------------------------------------------
  1447.  */
  1448.  
  1449. void
  1450. regerror(string)
  1451.     char *string;            /* Error message. */
  1452. {
  1453.     tclRegexpError = string;
  1454. }
  1455.